package com.zy.explore.demo.interfaces.feign;

import com.zy.explore.demo.infrastructure.constants.ProjectConstant;
import com.zy.explore.demo.interfaces.frm.SysUserFrm;
import com.zy.explore.demo.interfaces.vo.SysUserVO;

import com.zy.explore.frm.CommonIdIntFrm;
import com.zy.explore.vo.PageVO;
import com.zy.explore.vo.ResultVO;

import io.swagger.annotations.ApiOperation;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;

import javax.validation.Valid;
import java.util.List;

/**
 * 系统用户表(表sys_user)feign服务接口
 *
 * @author ZY
 * @date 2021-05-05 22:29:57
 */
@FeignClient(value = ProjectConstant.SERVICE_NAME, path = "/sysUser", contextId = ProjectConstant.SERVICE_NAME + ".sysUser")
public interface SysUserFeign {

    /**
     * 新增数据
     *
     * @param frm 待新增的frm对象
     * @return 成功返回新增后的VO对象，失败返回null
     */
    @ApiOperation("新增数据")
    @PostMapping("/insert")
    ResultVO<SysUserVO> insert(@RequestBody @Valid SysUserFrm frm);

    /**
     * 删除数据
     *
     * @param frm 主键frm对象
     * @return 1:删除成功 其他:删除失败
     */
    @ApiOperation("删除数据")
    @PostMapping("/delete")
    ResultVO<Integer> delete(@RequestBody @Valid CommonIdIntFrm frm);

    /**
     * 更新数据
     *
     * @param frm 待更新的frm对象
     * @return 成功返回更新后的VO对象，失败返回null
     */
    @ApiOperation("更新数据")
    @PostMapping("/update")
    ResultVO<SysUserVO> update(@RequestBody @Valid SysUserFrm frm);

    /**
     * 通过主键查询单条数据
     *
     * @param frm 主键Frm对象
     * @return 成功返回对应ID的VO对象，失败返回null
     */
    @ApiOperation("根据主键查询数据")
    @PostMapping("/getById")
    ResultVO<SysUserVO> getById(@RequestBody @Valid CommonIdIntFrm frm);

    /**
     * 根据条件获取数据集
     *
     * @param frm 查询条件对象
     * @return 成功返回满足条件的数据集合，失败返回空集合
     */
    @ApiOperation("根据条件查询数据集")
    @PostMapping("/getList")
    ResultVO<List<SysUserVO>> getList(@RequestBody @Valid SysUserFrm frm);

    /**
     * 根据条件查询数据分页
     *
     * @param frm 查询条件参数
     * @return 成功返回满足条件的分页，失败返回空页
     */
    @ApiOperation("根据条件查询数据分页")
    @PostMapping("/getPageInfo")
    ResultVO<PageVO<SysUserVO>> getPageInfo(@RequestBody @Valid SysUserFrm frm);

}